Favicon

You are here: Home > API Reference > Platform > Segment Permission > Preview segment permission

Preview segment permission

Required Permission: base.organization.segmentPermission.preview

Preview segment permission

POST
https://api.applivery.io/v1/organizations/{organizationId}/segment-permissions/preview 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/segment-permissions/preview" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "users": {
    "emails": [],
    "groups": []
  }
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/segment-permissions/preview", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "users": {
      "emails": [],
      "groups": []
    }
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/segment-permissions/preview",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "users": {
        "emails": [],
        "groups": []
      }
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
users object required
emails array [string] required
groups array [array] required 
{
    "users": {
        "emails": [
            "[email protected]"
        ],
        "groups": [
            [
                "string"
            ]
        ]
    }
}

Responses

200 Response application/json
status boolean required
data object required
matchedUsers array [string] required 
{
    "status": true,
    "data": {
        "matchedUsers": [
            "[email protected]"
        ]
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}